<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>dsirxss: Overview</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">dsirxss
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__dsirxss.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Overview</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_dsi2_rx_ss_sub_cores.html">Dsi2RxSsSubCores</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sub-Core Configuration Table.  <a href="struct_dsi2_rx_ss_sub_cores.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dsi2_rx_ss___config.html">XDsi2RxSs_Config</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">MIPI DSI Rx Subsystem configuration structure.  <a href="struct_x_dsi2_rx_ss___config.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dsi2_rx_ss.html">XDsi2RxSs</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="struct_x_dsi2_rx_ss.html" title="The XDsi2RxSs driver instance data. ">XDsi2RxSs</a> driver instance data.  <a href="struct_x_dsi2_rx_ss.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga82e139937b9632f2558d429c4ff5b82e"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsirxss.html#ga82e139937b9632f2558d429c4ff5b82e">XDsi2RxSs_Callback</a> )(void *CallbackRef, u32 Mask)</td></tr>
<tr class="memdesc:ga82e139937b9632f2558d429c4ff5b82e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback type for all interrupts defined.  <a href="#ga82e139937b9632f2558d429c4ff5b82e">More...</a><br/></td></tr>
<tr class="separator:ga82e139937b9632f2558d429c4ff5b82e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga0edea78461c3c71b2cbc6679d3d43d7b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsirxss.html#ga0edea78461c3c71b2cbc6679d3d43d7b">XDsi2RxSs_Selection</a> </td></tr>
<tr class="memdesc:ga0edea78461c3c71b2cbc6679d3d43d7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Subsystem Enable/Disable.  <a href="group__dsirxss.html#ga0edea78461c3c71b2cbc6679d3d43d7b">More...</a><br/></td></tr>
<tr class="separator:ga0edea78461c3c71b2cbc6679d3d43d7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga09a246136aab551ce3abd14f27a5c418"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsirxss.html#ga09a246136aab551ce3abd14f27a5c418">XDsi2RxSs_SubCore</a> </td></tr>
<tr class="memdesc:ga09a246136aab551ce3abd14f27a5c418"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sub-Core Enable/Disable.  <a href="group__dsirxss.html#ga09a246136aab551ce3abd14f27a5c418">More...</a><br/></td></tr>
<tr class="separator:ga09a246136aab551ce3abd14f27a5c418"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gacf02fba1186dd59ea301c448f21c6cce"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsirxss.html#gacf02fba1186dd59ea301c448f21c6cce">XDsi2RxSs_CfgInitialize</a> (<a class="el" href="struct_x_dsi2_rx_ss.html">XDsi2RxSs</a> *InstancePtr, <a class="el" href="struct_x_dsi2_rx_ss___config.html">XDsi2RxSs_Config</a> *CfgPtr, UINTPTR EffectiveAddr)</td></tr>
<tr class="memdesc:gacf02fba1186dd59ea301c448f21c6cce"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes the MIPI DSI RX subsystem and included sub-cores.  <a href="#gacf02fba1186dd59ea301c448f21c6cce">More...</a><br/></td></tr>
<tr class="separator:gacf02fba1186dd59ea301c448f21c6cce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa289941e9d71e4d0d890e7f8b3d51a37"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsirxss.html#gaa289941e9d71e4d0d890e7f8b3d51a37">XDsi2RxSs_DefaultConfigure</a> (<a class="el" href="struct_x_dsi2_rx_ss.html">XDsi2RxSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:gaa289941e9d71e4d0d890e7f8b3d51a37"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to configure the DSI2RX default parameters that are to be handled by the application.  <a href="#gaa289941e9d71e4d0d890e7f8b3d51a37">More...</a><br/></td></tr>
<tr class="separator:gaa289941e9d71e4d0d890e7f8b3d51a37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf332cc6cf666066eb9f5cad4c8e3213f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsirxss.html#gaf332cc6cf666066eb9f5cad4c8e3213f">XDsi2RxSs_Activate</a> (<a class="el" href="struct_x_dsi2_rx_ss.html">XDsi2RxSs</a> *InstancePtr, <a class="el" href="group__dsirxss.html#ga09a246136aab551ce3abd14f27a5c418">XDsi2RxSs_SubCore</a> core, u8 Flag)</td></tr>
<tr class="memdesc:gaf332cc6cf666066eb9f5cad4c8e3213f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to activate the DSI2RX Subsystem.  <a href="#gaf332cc6cf666066eb9f5cad4c8e3213f">More...</a><br/></td></tr>
<tr class="separator:gaf332cc6cf666066eb9f5cad4c8e3213f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga911fad210453719e9310c3b138096985"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsirxss.html#ga911fad210453719e9310c3b138096985">XDsi2RxSs_Reset</a> (<a class="el" href="struct_x_dsi2_rx_ss.html">XDsi2RxSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga911fad210453719e9310c3b138096985"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to reset the DSI2RX Subsystem.  <a href="#ga911fad210453719e9310c3b138096985">More...</a><br/></td></tr>
<tr class="separator:ga911fad210453719e9310c3b138096985"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9ddf0047db648a70d3a504fad94af7e1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsirxss.html#ga9ddf0047db648a70d3a504fad94af7e1">XDsi2RxSs_ReportCoreInfo</a> (<a class="el" href="struct_x_dsi2_rx_ss.html">XDsi2RxSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga9ddf0047db648a70d3a504fad94af7e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reports list of cores included in DSI RX Subsystem.  <a href="#ga9ddf0047db648a70d3a504fad94af7e1">More...</a><br/></td></tr>
<tr class="separator:ga9ddf0047db648a70d3a504fad94af7e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga77c35b7c60f267e093374252444b5f5f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsirxss.html#ga77c35b7c60f267e093374252444b5f5f">XDsi2RxSs_GetConfigParams</a> (<a class="el" href="struct_x_dsi2_rx_ss.html">XDsi2RxSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga77c35b7c60f267e093374252444b5f5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will get the information from the GUI settings.  <a href="#ga77c35b7c60f267e093374252444b5f5f">More...</a><br/></td></tr>
<tr class="separator:ga77c35b7c60f267e093374252444b5f5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5c30eee05917e5298c3af145ef0687b1"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsirxss.html#ga5c30eee05917e5298c3af145ef0687b1">XDsi2RxSs_IsControllerReady</a> (<a class="el" href="struct_x_dsi2_rx_ss.html">XDsi2RxSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga5c30eee05917e5298c3af145ef0687b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will get the information from the GUI settings.  <a href="#ga5c30eee05917e5298c3af145ef0687b1">More...</a><br/></td></tr>
<tr class="separator:ga5c30eee05917e5298c3af145ef0687b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2cf031088593839d8ea59b5a490033c4"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsirxss.html#ga2cf031088593839d8ea59b5a490033c4">XDsi2RxSs_GetPixelFormat</a> (<a class="el" href="struct_x_dsi2_rx_ss.html">XDsi2RxSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga2cf031088593839d8ea59b5a490033c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to get pixel format.  <a href="#ga2cf031088593839d8ea59b5a490033c4">More...</a><br/></td></tr>
<tr class="separator:ga2cf031088593839d8ea59b5a490033c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4efc5f50f88f952f7bb891a7744dcdaa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_dsi2_rx_ss___config.html">XDsi2RxSs_Config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsirxss.html#ga4efc5f50f88f952f7bb891a7744dcdaa">XDsi2RxSs_LookupConfig</a> (UINTPTR BaseAddress)</td></tr>
<tr class="memdesc:ga4efc5f50f88f952f7bb891a7744dcdaa"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function looks for the device configuration based on the unique device ID.  <a href="#ga4efc5f50f88f952f7bb891a7744dcdaa">More...</a><br/></td></tr>
<tr class="separator:ga4efc5f50f88f952f7bb891a7744dcdaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga007151e6775d2507f0988046b69e1b07"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsirxss.html#ga007151e6775d2507f0988046b69e1b07">XDsi2RxSs_GetDrvIndex</a> (<a class="el" href="struct_x_dsi2_rx_ss.html">XDsi2RxSs</a> *InstancePtr, UINTPTR BaseAddress)</td></tr>
<tr class="memdesc:ga007151e6775d2507f0988046b69e1b07"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the Index number of config table using BaseAddress.  <a href="#ga007151e6775d2507f0988046b69e1b07">More...</a><br/></td></tr>
<tr class="separator:ga007151e6775d2507f0988046b69e1b07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac41a4a217991dbc494383abe20dbc211"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsirxss.html#gac41a4a217991dbc494383abe20dbc211">XDsi2RxSs_SetCallback</a> (<a class="el" href="struct_x_dsi2_rx_ss.html">XDsi2RxSs</a> *InstancePtr, u32 HandlerType, void *CallbackFunc, void *CallbackRef)</td></tr>
<tr class="memdesc:gac41a4a217991dbc494383abe20dbc211"><td class="mdescLeft">&#160;</td><td class="mdescRight">This routine installs an asynchronous callback function for the given HandlerType:  <a href="#gac41a4a217991dbc494383abe20dbc211">More...</a><br/></td></tr>
<tr class="separator:gac41a4a217991dbc494383abe20dbc211"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae21d03381f99fe44f81736b43a3dfd9f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsirxss.html#gae21d03381f99fe44f81736b43a3dfd9f">XDsi2RxSs_IntrHandler</a> (void *InstancePtr)</td></tr>
<tr class="memdesc:gae21d03381f99fe44f81736b43a3dfd9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is the interrupt handler for the MIPI DSI2 Rx Subsystem.  <a href="#gae21d03381f99fe44f81736b43a3dfd9f">More...</a><br/></td></tr>
<tr class="separator:gae21d03381f99fe44f81736b43a3dfd9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacaec2c3ee2b7509f45c8882a8cf181ca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsirxss.html#gacaec2c3ee2b7509f45c8882a8cf181ca">XDsi2RxSs_SetGlobalInterrupt</a> (void *InstancePtr)</td></tr>
<tr class="memdesc:gacaec2c3ee2b7509f45c8882a8cf181ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will enable the interrupts present in the interrupt mask passed onto the function.  <a href="#gacaec2c3ee2b7509f45c8882a8cf181ca">More...</a><br/></td></tr>
<tr class="separator:gacaec2c3ee2b7509f45c8882a8cf181ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac03f22679082c95cb49fb34c0980034d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsirxss.html#gac03f22679082c95cb49fb34c0980034d">XDsi2RxSs_InterruptEnable</a> (void *InstancePtr, u32 Mask)</td></tr>
<tr class="memdesc:gac03f22679082c95cb49fb34c0980034d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will enable the interrupts present in the interrupt mask passed onto the function.  <a href="#gac03f22679082c95cb49fb34c0980034d">More...</a><br/></td></tr>
<tr class="separator:gac03f22679082c95cb49fb34c0980034d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga82e139937b9632f2558d429c4ff5b82e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* XDsi2RxSs_Callback)(void *CallbackRef, u32 Mask)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callback type for all interrupts defined. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">CallbackRef</td><td>is a callback reference passed in by the upper layer when setting the callback functions, and passed back to the upper layer when the callback is invoked. </td></tr>
    <tr><td class="paramname">Mask</td><td>is a bit mask indicating the cause of the event. For current core version, this parameter is "OR" of 0 or more XDSIRXSS_ISR_*_MASK constants defined in xdsirxss_hw.h.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga0edea78461c3c71b2cbc6679d3d43d7b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__dsirxss.html#ga0edea78461c3c71b2cbc6679d3d43d7b">XDsi2RxSs_Selection</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Subsystem Enable/Disable. </p>

</div>
</div>
<a class="anchor" id="ga09a246136aab551ce3abd14f27a5c418"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__dsirxss.html#ga09a246136aab551ce3abd14f27a5c418">XDsi2RxSs_SubCore</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sub-Core Enable/Disable. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaf332cc6cf666066eb9f5cad4c8e3213f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XDsi2RxSs_Activate </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dsi2_rx_ss.html">XDsi2RxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__dsirxss.html#ga09a246136aab551ce3abd14f27a5c418">XDsi2RxSs_SubCore</a>&#160;</td>
          <td class="paramname"><em>core</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>Flag</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is used to activate the DSI2RX Subsystem. </p>
<p>Internally it activates the DPHY and DSI2RX. Enable/Disable IP core to start processing</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">core</td><td>is used to denote the subcore of subsystem </td></tr>
    <tr><td class="paramname">Flag</td><td>is used to denote whether to enable or disable the subsystem</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS is returned if subcore(DSI/DPHY) was successfully enabled or disabled XST_INVALID_PARAM is returned if subsystem core is not found</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_dsi2_rx_ss.html#af283755e0c33ee6dc09e46001669daa4">XDsi2RxSs::Dsi2RxPtr</a>.</p>

</div>
</div>
<a class="anchor" id="gacf02fba1186dd59ea301c448f21c6cce"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XDsi2RxSs_CfgInitialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dsi2_rx_ss.html">XDsi2RxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_dsi2_rx_ss___config.html">XDsi2RxSs_Config</a> *&#160;</td>
          <td class="paramname"><em>CfgPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">UINTPTR&#160;</td>
          <td class="paramname"><em>EffectiveAddr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function initializes the MIPI DSI RX subsystem and included sub-cores. </p>
<p>This function must be called prior to using the subsystem. Initialization includes setting up the instance data for top level as well as all included sub-core therein, and ensuring the hardware is in a known stable state</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">CfgPtr</td><td>points to the configuration structure associated with the subsystem instance. </td></tr>
    <tr><td class="paramname">EffectiveAddr</td><td>is the base address of the device. If address translation is being used, then this parameter must reflect the virtual base address. Otherwise, the physical address should be used.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if initialization is successful</li>
<li>XST_FAILURE if initialization is failure</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_dsi2_rx_ss___config.html#a89d38ccb74c8a7f20fba792149999d9c">XDsi2RxSs_Config::BaseAddr</a>, <a class="el" href="struct_x_dsi2_rx_ss.html#a74e6ca6b80a3d4874e6e349059739827">XDsi2RxSs::Config</a>, <a class="el" href="struct_x_dsi2_rx_ss.html#af283755e0c33ee6dc09e46001669daa4">XDsi2RxSs::Dsi2RxPtr</a>, and <a class="el" href="struct_x_dsi2_rx_ss.html#a21fefc626aab09c5536c07a030e90674">XDsi2RxSs::IsReady</a>.</p>

<p>Referenced by <a class="el" href="xdsi2rxss__selftest__example_8c.html#aca3784ffa88ce005208db9acd21dc07c">Dsi2RxSs_SelfTestExample()</a>.</p>

</div>
</div>
<a class="anchor" id="gaa289941e9d71e4d0d890e7f8b3d51a37"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDsi2RxSs_DefaultConfigure </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dsi2_rx_ss.html">XDsi2RxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is used to configure the DSI2RX default parameters that are to be handled by the application. </p>
<p>It will configure protocol register with Pixel mode.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS on successful configuration of parameters</li>
<li>XST_FAILURE on failure scenraio</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_dsi2_rx_ss.html#af283755e0c33ee6dc09e46001669daa4">XDsi2RxSs::Dsi2RxPtr</a>.</p>

</div>
</div>
<a class="anchor" id="ga77c35b7c60f267e093374252444b5f5f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDsi2RxSs_GetConfigParams </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dsi2_rx_ss.html">XDsi2RxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will get the information from the GUI settings. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is the XDsi instance to operate on</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_dsi2_rx_ss.html#a4fc6ca6fd0b0cf3b9f474c549bf9293a">XDsi2RxSs::ConfigInfo</a>, and <a class="el" href="struct_x_dsi2_rx_ss.html#af283755e0c33ee6dc09e46001669daa4">XDsi2RxSs::Dsi2RxPtr</a>.</p>

</div>
</div>
<a class="anchor" id="ga007151e6775d2507f0988046b69e1b07"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDsi2RxSs_GetDrvIndex </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dsi2_rx_ss.html">XDsi2RxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">UINTPTR&#160;</td>
          <td class="paramname"><em>BaseAddress</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function returns the Index number of config table using BaseAddress. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">A</td><td>pointer to the instance structure</td></tr>
    <tr><td class="paramname">Base</td><td>address of the instance</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Index number of the config table </dd></dl>

</div>
</div>
<a class="anchor" id="ga2cf031088593839d8ea59b5a490033c4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDsi2RxSs_GetPixelFormat </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dsi2_rx_ss.html">XDsi2RxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is used to get pixel format. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the DsiRxSs Instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0x0E â€“ Packed RGB565 0x1E- packed RGB666 0x2E â€“ Loosely packed RGB666 0x3E- Packed RGB888 0x0B- Compressed Pixel Stream</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>References <a class="el" href="struct_x_dsi2_rx_ss.html#af283755e0c33ee6dc09e46001669daa4">XDsi2RxSs::Dsi2RxPtr</a>.</p>

</div>
</div>
<a class="anchor" id="gac03f22679082c95cb49fb34c0980034d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDsi2RxSs_InterruptEnable </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>Mask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will enable the interrupts present in the interrupt mask passed onto the function. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is the <a class="el" href="struct_x_dsi2_rx_ss.html" title="The XDsi2RxSs driver instance data. ">XDsi2RxSs</a> instance to operate on </td></tr>
    <tr><td class="paramname">Mask</td><td>is the interrupt mask which need to be enabled in core</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p>References <a class="el" href="struct_x_dsi2_rx_ss.html#af283755e0c33ee6dc09e46001669daa4">XDsi2RxSs::Dsi2RxPtr</a>.</p>

</div>
</div>
<a class="anchor" id="gae21d03381f99fe44f81736b43a3dfd9f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDsi2RxSs_IntrHandler </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is the interrupt handler for the MIPI DSI2 Rx Subsystem. </p>
<p>The application is responsible for connecting this function to the interrupt system. Application beyond this driver is also responsible for providing callbacks to handle interrupts and installing the callbacks using <a class="el" href="group__dsirxss.html#gac41a4a217991dbc494383abe20dbc211" title="This routine installs an asynchronous callback function for the given HandlerType: ...">XDsi2RxSs_SetCallback()</a> during initialization phase.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_dsi2_rx_ss.html" title="The XDsi2RxSs driver instance data. ">XDsi2RxSs</a> core instance that just interrupted.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_dsi2_rx_ss.html#af283755e0c33ee6dc09e46001669daa4">XDsi2RxSs::Dsi2RxPtr</a>.</p>

</div>
</div>
<a class="anchor" id="ga5c30eee05917e5298c3af145ef0687b1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDsi2RxSs_IsControllerReady </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dsi2_rx_ss.html">XDsi2RxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will get the information from the GUI settings. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is the <a class="el" href="struct_x_dsi2_rx_ss.html" title="The XDsi2RxSs driver instance data. ">XDsi2RxSs</a> instance to operate on</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Controller ready status</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_dsi2_rx_ss.html#af283755e0c33ee6dc09e46001669daa4">XDsi2RxSs::Dsi2RxPtr</a>.</p>

</div>
</div>
<a class="anchor" id="ga4efc5f50f88f952f7bb891a7744dcdaa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_dsi2_rx_ss___config.html">XDsi2RxSs_Config</a> * XDsi2RxSs_LookupConfig </td>
          <td>(</td>
          <td class="paramtype">UINTPTR&#160;</td>
          <td class="paramname"><em>BaseAddress</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function looks for the device configuration based on the unique device ID. </p>
<p>The table XDsi2RxSs_ConfigTable[] contains the configuration information for each instance of the device in the system.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>is the unique address of the device being looked up</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the configuration table entry corresponding to the given device ID, or NULL if no match is found</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>Referenced by <a class="el" href="xdsi2rxss__selftest__example_8c.html#aca3784ffa88ce005208db9acd21dc07c">Dsi2RxSs_SelfTestExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ga9ddf0047db648a70d3a504fad94af7e1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDsi2RxSs_ReportCoreInfo </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dsi2_rx_ss.html">XDsi2RxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reports list of cores included in DSI RX Subsystem. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the DSI RX Subsystem instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_dsi2_rx_ss.html#a74e6ca6b80a3d4874e6e349059739827">XDsi2RxSs::Config</a>, <a class="el" href="struct_x_dsi2_rx_ss___config.html#aeb9967254fd9e94cc7fa5973eb9ffb41">XDsi2RxSs_Config::DphyInfo</a>, <a class="el" href="struct_x_dsi2_rx_ss.html#af283755e0c33ee6dc09e46001669daa4">XDsi2RxSs::Dsi2RxPtr</a>, and <a class="el" href="struct_dsi2_rx_ss_sub_cores.html#af1648a6faac314b37a62910c3c248f98">Dsi2RxSsSubCores::IsPresent</a>.</p>

</div>
</div>
<a class="anchor" id="ga911fad210453719e9310c3b138096985"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDsi2RxSs_Reset </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dsi2_rx_ss.html">XDsi2RxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is used to reset the DSI2RX Subsystem. </p>
<p>Internally it resets the DPHY and DSI</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_dsi2_rx_ss.html#a74e6ca6b80a3d4874e6e349059739827">XDsi2RxSs::Config</a>, <a class="el" href="struct_x_dsi2_rx_ss.html#af283755e0c33ee6dc09e46001669daa4">XDsi2RxSs::Dsi2RxPtr</a>, and <a class="el" href="struct_x_dsi2_rx_ss___config.html#a990e7b739eaf7b9cca5d69346756afc9">XDsi2RxSs_Config::IsDphyRegIntfcPresent</a>.</p>

</div>
</div>
<a class="anchor" id="gac41a4a217991dbc494383abe20dbc211"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDsi2RxSs_SetCallback </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dsi2_rx_ss.html">XDsi2RxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>HandlerType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallbackFunc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallbackRef</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This routine installs an asynchronous callback function for the given HandlerType: </p>
<pre>
HandlerType                     Invoked by this driver when:
-----------------------  --------------------------------------------------
XDSI2RX_HANDLER_UNSUPPORT_DATATYPE      Unsupported data type
XDSI2RX_HANDLER_CRC_ERROR               CRC error
XDSI2RX_HANDLER_ECC1_BIT_ERROR  ECC 1 bit error
XDSI2RX_HANDLER_ECC2_BIT_ERROR  ECC 2 bit error
XDSI2RX_HANDLER_SOT_SYNC_ERR_LANE1      SOT sync error on line 1
XDSI2RX_HANDLER_SOT_ERR_LANE1           SOT error on line 1
XDSI2RX_HANDLER_SOT_SYNC_ERR_LANE2      SOT sync error on line 2
XDSI2RX_HANDLER_SOT_ERR_LANE2           SOT error on line 2
XDSI2RX_HANDLER_SOT_SYNC_ERR_LANE3      SOT sync error on line 3
XDSI2RX_HANDLER_SOT_ERR_LANE3           SOT error on line 3
XDSI2RX_HANDLER_SOT_SYNC_ERR_LANE4      SOT sync error on line 4
XDSI2RX_HANDLER_SOT_ERR_LANE4           SOT error on line 4
XDSI2RX_HANDLER_STOP_STATE              STOP state
XDSI2RX_HANDLER_LM_ASYNC_FIFO_FULL      Long msg asyn fifo full.
XDSI2RX_HANDLER_STREAM_ASYNC_FIFO_FULL stream async fifo full
XDSI2RX_HANDLER_GSP_FIFO_NE             generic short packet fifo not empty
XDSI2RX_HANDLER_GSP_FIFO_FULL           generic short packet fifo full
XDSI2RX_HANDLER_FRAME_STARTED           frame started</pre><pre>*
</pre><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is the XDsi2Rx instance to operate on </td></tr>
    <tr><td class="paramname">HandlerType</td><td>is the type of call back to be registered. </td></tr>
    <tr><td class="paramname">CallbackFunc</td><td>is the pointer to a call back funtion which is called when a particular event occurs. </td></tr>
    <tr><td class="paramname">CallbackRef</td><td>is a void pointer to data to be referenced to by the CallbackFunc</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS when handler is installed.</li>
</ul>
</dd></dl>
<ul>
<li>XST_INVALID_PARAM when HandlerType is invalid.</li>
</ul>
<dl class="section note"><dt>Note</dt><dd>Invoking this function for a handler that already has been installed replaces it with the new handler. </dd></dl>

<p>References <a class="el" href="struct_x_dsi2_rx_ss.html#af283755e0c33ee6dc09e46001669daa4">XDsi2RxSs::Dsi2RxPtr</a>, and <a class="el" href="struct_x_dsi2_rx_ss.html#a21fefc626aab09c5536c07a030e90674">XDsi2RxSs::IsReady</a>.</p>

</div>
</div>
<a class="anchor" id="gacaec2c3ee2b7509f45c8882a8cf181ca"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDsi2RxSs_SetGlobalInterrupt </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will enable the interrupts present in the interrupt mask passed onto the function. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is the <a class="el" href="struct_x_dsi2_rx_ss.html" title="The XDsi2RxSs driver instance data. ">XDsi2RxSs</a> instance to operate on</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_dsi2_rx_ss.html#af283755e0c33ee6dc09e46001669daa4">XDsi2RxSs::Dsi2RxPtr</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
